home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 051-075 / disk_074 / cled / cled.doc < prev   
Text File  |  1992-05-06  |  11KB  |  251 lines
  1.                                 CLED    v1.3
  2.                             (Command Line EDitor)
  3.                                 May 1, 1987
  4.  
  5.                                     by
  6.  
  7.                                Pat R. Empleo
  8.                                April 21, 1987
  9.  
  10.  
  11.  
  12.  
  13. =============================   INTRODUCTION   =================================
  14.  
  15. CLED is a simple command line editor which allows you to edit your commands
  16. before and after they are processed by your Amiga. It uses the arrow keys and
  17. simple <CTRL> sequence keystrokes to position the cursor and to perform editing
  18. tasks. It also keeps a history of past commands for recall, editing, and
  19. resubmission.
  20.  
  21. It currently requires roughly 13K of your precious RAM.
  22.  
  23. The sole purpose for creating CLED is to provide command line editing capability
  24. to the Amiga CLI environment. It is not intended to be a full-blown shell which
  25. provides additional commands such as aliases or macros. In fact, there are
  26. currently only three such "internal commands" in CLED.
  27.  
  28.  
  29.  
  30.  
  31. ==============================   RESTRICTIONS   ================================
  32.  
  33. Like every man-made thing on this planet, CLED (especially CLED) is not perfect.
  34. Still, CLED is very useful in its present form, especially if you're use to
  35. operating systems such as VMS and/or are a lousy typist like myself.
  36.  
  37. The following limitations (that I've found so far) are discussed in order of
  38. severity ... 
  39.  
  40. 1. AmigaDOS EXECUTE command:
  41.    This is the big one!! Typing "EXECUTE filename" on the CLED command line
  42.    will not work. There is currently no script facility in CLED. In order to
  43.    execute script files, you must type "RUN EXECUTE filename". This implies that
  44.    some DOS commands and other programs evoked from within the script file may
  45.    not work as expected. Specifically, any program requiring input from an
  46.    interactive CLI will not work. Also, the DOS commands, CD and PATH, will be
  47.    valid only for the non-interactive CLI that was started and only until it
  48.    terminates. If you do type "EXECUTE whatever", then the command will not
  49.    execute until you have exited CLED. Simply exit CLED if your script file
  50.    does not execute correctly.
  51.  
  52.    I toyed with the idea of adding script capablility to CLED, but the idea of
  53.    duplicating what the AmigaDOS EXECUTE command does in a "normal", interactive
  54.    CLI window horrified me! All I want is to edit the command line!
  55.  
  56. 2. AmigaDOS Template feature:
  57.    Trying to display the templates of AmigaDOS commands won't work. For example,
  58.    typing "DATE ?" or "DIR ?" will only get you a "Bad arguments" message.
  59.  
  60. 3. CLED PROMPT command:
  61.    The CLED PROMPT command does not have a %n feature like the AmigaDOS version.
  62.    Typing "PROMPT whatever" on the command line will evoke the CLED PROMPT
  63.    (see the CLED COMMANDS section). Typing "RUN PROMPT whatever" will evoke the
  64.    AmigaDOS PROMPT, however, your new prompt will not appear until you've exited
  65.    CLED.
  66.  
  67. 4. AmigaDOS RUN command:
  68.    Using the RUN command in the form "RUN command+command+command,,,,,,,,,"
  69.    doesn't work. Does anyone ever use this????
  70.  
  71. 5. Currently, CLED does not allow "stacking of commands".
  72.  
  73. 6. CLED runs only under 1.2 of the Amiga operating system.
  74.  
  75. 7. CLED keeps only the last 30 commands. I'll probably add a command so you can
  76.    change the limit of the history stack.
  77.  
  78. 8. CLED is always in insert mode. I doubt if I'll add overwrite capability
  79.    ------ I NEVER had the need.
  80.  
  81.  
  82.  
  83.  
  84. =================================   USAGE   ====================================
  85.  
  86. Format:   cled [string [color]]
  87.  
  88. Place CLED in your C: directory or define a PATH to it.
  89.  
  90. CLED is invoked by typing "cled" at the CLI command line, with or without
  91. arguments. The optional arguments allow you to specify a prompt and its color
  92. when CLED starts up (see CLED COMMANDS - prompt). Don't start the program by
  93. typing "run cled" or thereafter, your display will become extremely confusing.
  94.  
  95. If CLED is to be included in the startup-sequence script file, it should be the
  96. last statement in the file or else commands that follow will not be executed
  97. until CLED is exited.
  98.  
  99.  
  100.  
  101.  
  102. ===========================   EDITING COMMANDS   ===============================
  103.                                                                               
  104. Keystrokes      Action                                                
  105. ----------      ----------------------------------------------------------------
  106. Up-arrow        Scrolls up through the previous commands (history) entered on
  107.                 the command line
  108.                                                                               
  109. Down-arrow      Scrolls down through the previous commands (history) entered on
  110.                 the command line
  111.                                                                               
  112. Left-arrow      Moves cursor left through the command string          
  113.                                                                              
  114. Right-arrow     Moves cursor right through the command string         
  115.                                                                               
  116. <DEL>           Forward deletes character on the command line         
  117.                                                                               
  118. Shift-Left-     Moves cursor to the Beginning of the command string   
  119. Arrow or ^B                                                        
  120.  
  121. ^D              Delete from cursor to end of command line
  122.  
  123. Shift-Right-    Moves cursor to the End of the command string         
  124. Arrow or ^E                                                        
  125.                                                                               
  126. <BS> or ^H      Backward deletes character on the command line        
  127.                                                                              
  128. <HELP>          Displays history of the commands entered on the command line.
  129.                 If a history number (displayed next to the command string) is
  130.                 entered on the command line, the corresponding command string
  131.                 will be placed on the command line for resubmittal or editing
  132.                                                                             
  133. <RET> or ^M     Submits the command which the cursor is on for processing; the
  134.                 cursor does not have to be at the end of the command string. If
  135.                 the string is a history number, its corresponding command will
  136.                 be placed on the command line
  137.  
  138. ^W              Move forward to next word
  139.  
  140. ^X or ^U        Erases the command line. "Clicking" the window's resizing
  141.                 gadget will also clear the line.
  142.  
  143. ^key            Clears the screen. Pressing any valid ^key combination other
  144.                 than the ones discussed in this document will clear the screen.
  145.  
  146.  
  147.  
  148.  
  149. ============================   CLED COMMANDS   =================================
  150.  
  151. Command         Action
  152. -------         ----------------------------------------------------------------
  153. <TAB>           Executes the commands corresponding to a list of history numbers
  154.                 entered at the command line. The numbers must be separated by
  155.                 spaces.
  156.  
  157.                 Format:        n1 n2 n3 ... nn<TAB>
  158.  
  159.                 Parameters:    n      - History numbers; pressing the <HELP> key
  160.                                         will display a history of commands, and
  161.                                         high-lighted to the right are their
  162.                                         corresponding numbers. The numbers can
  163.                                         listed in any order desired
  164.  
  165.                                <TAB>  - Pressing the <TAB> key or typing ^I
  166.                                         will submit the numbers for processing.
  167.                                         The cursor need not be at the end of the
  168.                                         line
  169.  
  170.                 Example:       2 25 6 8 1<TAB>
  171.                                2 2 2 3 3 29 1 1 1 3<TAB>
  172.  
  173.  
  174. prompt          Changes the prompt and optionally its color.
  175.  
  176.                 Format:        prompt string [color]
  177.  
  178.                 Parameters:    string - New prompt string; if the new prompt has
  179.                                         imbedded spaces, then the string must
  180.                                         be enclosed in quotes. Escape sequences
  181.                                         can be included in the string, but only
  182.                                         at the front; this allows for further
  183.                                         customizing of your prompt. On CLED
  184.                                         startup, the default prompt is ">>- ".
  185.  
  186.                                color  - Color of the prompt where color is one
  187.                                         of the following numerical values:
  188.  
  189.                                            1  WorkBench foreground color
  190.                                            2  WorkBench gadgets color
  191.                                            3  WorkBench cursor color
  192.                                            
  193.                                         This parameter is optional. If no value
  194.                                         is given, the current color is used. 
  195.                                         The history numbers will also be
  196.                                         displayed in the current color. On
  197.                                         CLED startup, the default color is 3.
  198.  
  199.                 Examples:      prompt "Hi There! "
  200.                                prompt "$ " 2
  201.                                prompt "<ESC>[3;32;40mYes Master? " 3
  202.  
  203.  
  204. exit            Deallocates any allocated memory and exits to the system CLI.
  205.  
  206.                 Format:        exit
  207.  
  208.                 Parameters:    n/a
  209.  
  210.                 Example:       exit            (Simple huh??!?)
  211.  
  212.  
  213.  
  214.  
  215. ================================  REVISIONS  ===================================
  216.  
  217. v1.3   (05/01/87)   CLED now works correctly when CHANGETASKPRIed higher than 4;
  218.  
  219. v1.2   (04/29/87)   ^E bug fix
  220.  
  221. v1.1   (04/24/87)   Added ^D, delete from cursor to end of command line;
  222.                     Added ^W, advance cursor to next word;
  223.  
  224. v1.0   (04/22/87)   Initial Release
  225.  
  226.  
  227.  
  228.  
  229. =================================   NOTES   ====================================
  230.  
  231. CLED was compiled and linked using MANX Aztec C68K, v3.4a
  232.  
  233. If you have any questions, suggestions, flames, or find any bugs, you can
  234. contact me during my normal slave hours of 8:00 AM to 4:00 PM at (408)778-4644
  235. (voice only, sorry).
  236.  
  237.                                                    Pat R. Empleo
  238.                                                    May 1, 1987
  239.  
  240.  
  241.  
  242.  
  243. ==============================   DISTRIBUTION   ================================
  244.  
  245. This program is placed in the PUBLIC DOMAIN. You may do as you wish with it
  246. (which isn't much) except sell it, but please keep the distributed ARCed file
  247. intact, and do not remove this documentation (or my name for that matter).
  248.  
  249. If you fail to abide with the above, may the Great GURU curse your bits forever,
  250. or at least until you croak from radiation from your CRT!!!
  251.